<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="identitytoolkit_v2.html">Identity Toolkit API</a> . <a href="identitytoolkit_v2.accounts.html">accounts</a> . <a href="identitytoolkit_v2.accounts.mfaEnrollment.html">mfaEnrollment</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#finalize">finalize(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Finishes enrolling a second factor for the user.</p>
<p class="toc_element">
  <code><a href="#start">start(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Step one of the MFA enrollment process. In SMS case, this sends an SMS verification code to the user.</p>
<p class="toc_element">
  <code><a href="#withdraw">withdraw(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Revokes one second factor from the enrolled second factors for an account.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="finalize">finalize(body=None, x__xgafv=None)</code>
  <pre>Finishes enrolling a second factor for the user.

Args:
  body: object, The request body.
    The object takes the form of:

{ # Finishes enrolling a second factor for the user.
  &quot;displayName&quot;: &quot;A String&quot;, # Display name which is entered by users to distinguish between different second factors with same type or different type.
  &quot;idToken&quot;: &quot;A String&quot;, # Required. ID token.
  &quot;phoneVerificationInfo&quot;: { # Phone Verification info for a FinalizeMfa request. # Verification info to authorize sending an SMS for phone verification.
    &quot;androidVerificationProof&quot;: &quot;A String&quot;, # Android only. Uses for &quot;instant&quot; phone number verification though GmsCore.
    &quot;code&quot;: &quot;A String&quot;, # User-entered verification code.
    &quot;phoneNumber&quot;: &quot;A String&quot;, # Required if Android verification proof is presented.
    &quot;sessionInfo&quot;: &quot;A String&quot;, # An opaque string that represents the enrollment session.
  },
  &quot;tenantId&quot;: &quot;A String&quot;, # The ID of the Identity Platform tenant that the user enrolling MFA belongs to. If not set, the user belongs to the default Identity Platform project.
  &quot;totpVerificationInfo&quot;: { # Mfa request info specific to TOTP auth for FinalizeMfa. # Verification information for TOTP.
    &quot;sessionInfo&quot;: &quot;A String&quot;, # An opaque string that represents the enrollment session.
    &quot;verificationCode&quot;: &quot;A String&quot;, # User-entered verification code.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # FinalizeMfaEnrollment response.
  &quot;idToken&quot;: &quot;A String&quot;, # ID token updated to reflect MFA enrollment.
  &quot;phoneAuthInfo&quot;: { # Phone Verification info for a FinalizeMfa response. # Auxiliary auth info specific to phone auth.
    &quot;androidVerificationProof&quot;: &quot;A String&quot;, # Android only. Long-lived replacement for valid code tied to android device.
    &quot;androidVerificationProofExpireTime&quot;: &quot;A String&quot;, # Android only. Expiration time of verification proof in seconds.
    &quot;phoneNumber&quot;: &quot;A String&quot;, # For Android verification proof.
  },
  &quot;refreshToken&quot;: &quot;A String&quot;, # Refresh token updated to reflect MFA enrollment.
  &quot;totpAuthInfo&quot;: { # Mfa response info specific to TOTP auth for FinalizeMfa. # Auxiliary auth info specific to TOTP auth.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="start">start(body=None, x__xgafv=None)</code>
  <pre>Step one of the MFA enrollment process. In SMS case, this sends an SMS verification code to the user.

Args:
  body: object, The request body.
    The object takes the form of:

{ # Sends MFA enrollment verification SMS for a user.
  &quot;idToken&quot;: &quot;A String&quot;, # Required. User&#x27;s ID token.
  &quot;phoneEnrollmentInfo&quot;: { # App Verification info for a StartMfa request. # Verification info to authorize sending an SMS for phone verification.
    &quot;autoRetrievalInfo&quot;: { # The information required to auto-retrieve an SMS. # Android only. Used by Google Play Services to identify the app for auto-retrieval.
      &quot;appSignatureHash&quot;: &quot;A String&quot;, # The Android app&#x27;s signature hash for Google Play Service&#x27;s SMS Retriever API.
    },
    &quot;captchaResponse&quot;: &quot;A String&quot;, # The reCAPTCHA Enterprise token provided by the reCAPTCHA client-side integration. Required when reCAPTCHA enterprise is enabled.
    &quot;clientType&quot;: &quot;A String&quot;, # The client type, web, android or ios. Required when reCAPTCHA Enterprise is enabled.
    &quot;iosReceipt&quot;: &quot;A String&quot;, # iOS only. Receipt of successful app token validation with APNS.
    &quot;iosSecret&quot;: &quot;A String&quot;, # iOS only. Secret delivered to iOS app via APNS.
    &quot;phoneNumber&quot;: &quot;A String&quot;, # Required for enrollment. Phone number to be enrolled as MFA.
    &quot;playIntegrityToken&quot;: &quot;A String&quot;, # Android only. Used to assert application identity in place of a recaptcha token (or safety net token). A Play Integrity Token can be generated via the [PlayIntegrity API] (https://developer.android.com/google/play/integrity) with applying SHA256 to the `phone_number` field as the nonce.
    &quot;recaptchaToken&quot;: &quot;A String&quot;, # Web only. Recaptcha solution.
    &quot;recaptchaVersion&quot;: &quot;A String&quot;, # The reCAPTCHA version of the reCAPTCHA token in the captcha_response. Required when reCAPTCHA Enterprise is enabled.
    &quot;safetyNetToken&quot;: &quot;A String&quot;, # Android only. Used to assert application identity in place of a recaptcha token. A SafetyNet Token can be generated via the [SafetyNet Android Attestation API](https://developer.android.com/training/safetynet/attestation.html), with the Base64 encoding of the `phone_number` field as the nonce.
  },
  &quot;tenantId&quot;: &quot;A String&quot;, # The ID of the Identity Platform tenant that the user enrolling MFA belongs to. If not set, the user belongs to the default Identity Platform project.
  &quot;totpEnrollmentInfo&quot;: { # Mfa request info specific to TOTP auth for StartMfa. # Sign-in info specific to TOTP auth.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # StartMfaEnrollment response.
  &quot;phoneSessionInfo&quot;: { # Phone Verification info for a StartMfa response. # Verification info to authorize sending an SMS for phone verification.
    &quot;sessionInfo&quot;: &quot;A String&quot;, # An opaque string that represents the enrollment session.
  },
  &quot;totpSessionInfo&quot;: { # Mfa response info specific to TOTP auth for StartMfa. # Enrollment response info specific to TOTP auth.
    &quot;finalizeEnrollmentTime&quot;: &quot;A String&quot;, # The time by which the enrollment must finish.
    &quot;hashingAlgorithm&quot;: &quot;A String&quot;, # The hashing algorithm used to generate the verification code.
    &quot;periodSec&quot;: 42, # Duration in seconds at which the verification code will change.
    &quot;sessionInfo&quot;: &quot;A String&quot;, # An encoded string that represents the enrollment session.
    &quot;sharedSecretKey&quot;: &quot;A String&quot;, # A base 32 encoded string that represents the shared TOTP secret. The base 32 encoding is the one specified by [RFC4648#section-6](https://datatracker.ietf.org/doc/html/rfc4648#section-6). (This is the same as the base 32 encoding from [RFC3548#section-5](https://datatracker.ietf.org/doc/html/rfc3548#section-5).)
    &quot;verificationCodeLength&quot;: 42, # The length of the verification code that needs to be generated.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="withdraw">withdraw(body=None, x__xgafv=None)</code>
  <pre>Revokes one second factor from the enrolled second factors for an account.

Args:
  body: object, The request body.
    The object takes the form of:

{ # Withdraws MFA.
  &quot;idToken&quot;: &quot;A String&quot;, # Required. User&#x27;s ID token.
  &quot;mfaEnrollmentId&quot;: &quot;A String&quot;, # Required. MFA enrollment id from a current MFA enrollment.
  &quot;tenantId&quot;: &quot;A String&quot;, # The ID of the Identity Platform tenant that the user unenrolling MFA belongs to. If not set, the user belongs to the default Identity Platform project.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Withdraws MultiFactorAuth response.
  &quot;idToken&quot;: &quot;A String&quot;, # ID token updated to reflect removal of the second factor.
  &quot;refreshToken&quot;: &quot;A String&quot;, # Refresh token updated to reflect removal of the second factor.
}</pre>
</div>

</body></html>